Skip to main content

User Entities

These objects are used by the User adapter functions and describe Epicenter users.

Interfaces​

Secret​

The Secret interface is not exported. It defines a structure for user credentials.

Properties​

  • password (string): The user's password.

User​

The User interface defines the structure of a user object.

Properties​

  • lastUpdated (string): Timestamp of the last update.
  • displayName (string): The user's display name.
  • givenName (string): Given name of the user.
  • familyName (string): Family name of the user.
  • handle (string): The login user handle.
  • created (string): Timestamp of user creation.
  • detail (Record<string, unknown>): Additional details about the user.
  • userId (number): Unique numeric identifier for the user.
  • userKey (string): GUID key identifying the user.
  • objectType ('external' | 'native'): Specifies whether the user is external or native.

UserCreateView​

The UserCreateView interface defines the structure for creating a user.

Properties​

  • [key: string]: unknown: Additional dynamic properties.
  • handle (string): Unique handle for the user.
  • email? (string): (Optional) User's email address.
  • givenName? (string): (Optional) User's given name.
  • familyName? (string): (Optional) User's family name.
  • active? (true): (Optional) Indicates if the user is active.

NativeUserCreateView​

The NativeUserCreateView interface extends UserCreateView to define the structure for creating a native user.

Properties​

  • objectType ('native'): Specifies that the user is a native user.
  • secret (Secret): The secret credentials for the user.

ExternalUserCreateView​

The ExternalUserCreateView interface extends UserCreateView to define the structure for creating an external user.

Properties​

  • objectType ('external'): Specifies that the user is an external user.

UploadOptions​

The UploadOptions interface is not exported. It extends RoutingOptions to define options for file uploads.

Properties​

  • groupKey? (string): (Optional) Unique key of the group.
  • overwrite? (boolean): (Optional) Indicates if an existing file should be overwritten.

Types​

Modality​

The Modality type is not exported. It defines the allowed string values representing user modality.

Type values​

  • 'NONE': Indicates that no specific modality is being applied.
  • 'SSO': Indicates that the user logged in via SSO.